Add value-first integration plan for browser MP3 cleanse flow#7
Closed
ChrisAdamsdevelopment wants to merge 1 commit into
Closed
Conversation
Reviewer's GuideAdds a new documentation file outlining a phased, value-first integration plan for a browser-based MP3 metadata cleanse flow into the existing SpectraCleanse app, including UX flows, frontend/backend architecture, implementation phases, technical guardrails, metrics, and acceptance criteria. Sequence diagram for Quick Cleanse browser MP3 flowsequenceDiagram
actor User
participant UI as BrowserUI
participant Meta as MetadataUtils
participant SEO as ApiGenerateSEO
User->>UI: Upload MP3 file
UI->>Meta: parseMetadata file
Meta-->>UI: metadata + risk markers
UI->>User: Display metadata and risk markers
User->>UI: Click Generate SEO
UI->>SEO: POST /api/generate-seo with context
SEO-->>UI: seoData
UI->>User: Show SEO Payload tab with editable fields
User->>UI: Click Cleanse
UI->>Meta: writeCleanMp3 file seoData
Meta-->>UI: cleansedFileBlob
UI->>User: Enable Download Processed File button
User->>UI: Click Download
UI->>User: Trigger manual download
UI->>UI: Revoke previous blob URLs
Class diagram for metadata utilities and cleanse state machineclassDiagram
class MetadataUtils {
+parseMetadata fileBlob
+detectRiskMarkers metadata
+rewriteMp3Id3 fileBlob seoData
+createBlobUrl fileBlob
+revokeBlobUrl blobUrl
}
class CleanseStateMachine {
-state string
+setIdle()
+setAnalyzing()
+setGenerating()
+setCleansing()
+setReady()
+canGenerateSEO() bool
+canCleanse() bool
}
class SeoData {
+title string
+description string
+tags string[]
+lyrics string
}
class RiskMarker {
+name string
+severity string
+sourceTag string
}
MetadataUtils "1" --> "*" RiskMarker : detects
MetadataUtils --> SeoData : consumes
CleanseStateMachine --> SeoData : guardsOperations
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider specifying the exact
src/utils/metadataAPI shape (e.g., function names and return types) so future implementation remains consistent with the planned state machine and backend contracts. - It may help to explicitly document how the
VITE_ENABLE_BROWSER_MP3_CLEANSEflag interacts with existing config/env loading in this app (e.g., expected default value and behavior when unset) to avoid inconsistent rollout behavior.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider specifying the exact `src/utils/metadata` API shape (e.g., function names and return types) so future implementation remains consistent with the planned state machine and backend contracts.
- It may help to explicitly document how the `VITE_ENABLE_BROWSER_MP3_CLEANSE` flag interacts with existing config/env loading in this app (e.g., expected default value and behavior when unset) to avoid inconsistent rollout behavior.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closed as superseded planning work. The implementation path landed through PR #8 for stabilization and PR #9 for browser MP3 quick cleanse integration.